Summary

Writes a search form html code to the output stream. The code is included in a form element and contains a textbox and a submit button. This component should be used to submit data to a page that contains a component such as "Search result for categories" that can perform the search and display the result.

Component properties
Category AS Search
Version 1.0
Complies with Xhtml 1.0 / 1.1 rules Yes
Supported server programming languages C# Visual Basic.NET
Output content type block

When to use

This component is typically used to submit a user's fulltext search argument to the Seach result for categories component that displays the result. 

Programming interface

Parameters

Component name prefix
A unique prefix to provide for the component. Pass an empty string or "CS_" unless there are multiple instances of the component on a single document.
Target document
A Content Studio document that should receive the search data. This document must contain a component that can perform the search and display the result.
Presentation template
A optional presentation template used by the target document.
SearchFieldName
The name of the search field
ButtonText
The text of the displayed search button
Target
The name of the target of destination frame. This parameter must be empty when using XHTML 1.0 strict, XHTML 1.1 or later.
ButtonClassName
The name of a CSS class to be applied on the submit button. This argument should be empty if not applicable.
TextFieldClassName
The name of a CSS class to be applied on the text field. This argument should be empty if not applicable.
Omit in EPT schema
Set this parameter to true to omit the field in the EPT-schema. This parameter has no meaning unless the component is located on an edit templates.

Remarks

This component renders its own FORM element and does not work with a ASP.NET form (runat="server"). In this case the developers should submit the search argument to the Search result for categories component or call the underlying Search APISearch API for Search result for categories themselves.